IMotion.InchAxis method

Commands a never-ending controlled motion at a specified velocity with a maximum distance. After the axis reaches the maximum distance it will automatically stop.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsCommandStatus InchAxis(
       int Index,
       double Distance,
       double Velocity,
       double Acceleration,
       double Deceleration,
       double Jerk,
       McDirection Direction
)

Function InchAxis(
       Index As Integer,
       Distance As Double,
       Velocity As Double,
       Acceleration As Double,
       Deceleration As Double,
       Jerk As Double,
       Direction As McDirection
) As KsCommandStatus

Parameters

Index [in]

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Distance [in]

Type: double

The maximum distance traveled by this move.

Velocity [in]

Type: double

A value of the specified velocity. [unit/second]

Acceleration [in]

Type: double

A value of the acceleration. The unit is determined by McProfileType. (increasing energy of the motor) [unit/second²] or [second]

Deceleration [in]

Type: double

A value of the deceleration. The unit is determined by McProfileType. (decreasing energy of the motor) [unit/second²] or [second]

Jerk [in]

Type: double

A value of the jerk. The unit is determined by McProfileType. [unit/second³] or [second]

Direction [in]

Type: McDirection

The direction of the inch move. It's mcPositiveDirection or mcNegativeDirection.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Examples

N/A

See also

IMotion Interface

IntervalZero.KINGSTAR.Base.Api Namespace